WebAPI 和 OpenAPI 是不同的概念,但它們在設計和實現 API 時有緊密的關聯。以下是兩者的區別與簡單實作範例:
WebAPI 是一種通過 HTTP 協議提供數據和服務的接口。WebAPI 一般使用 REST 架構,它允許使用者通過標準的 HTTP 方法(GET, POST, PUT, DELETE)來與系統進行交互。
from flask import Flask, jsonify, request
app = Flask(__name__)
# 一個簡單的 GET API 端點
@app.route('/api/v1/items', methods=['GET'])
def get_items():
items = [
{'id': 1, 'name': 'Item 1'},
{'id': 2, 'name': 'Item 2'}
]
return jsonify(items)
# 一個 POST API 端點,用來添加新項目
@app.route('/api/v1/items', methods=['POST'])
def add_item():
new_item = request.json
# 模擬添加新項目
return jsonify(new_item), 201
if __name__ == '__main__':
app.run(debug=True)
這個 WebAPI 提供兩個端點:
GET /api/v1/items
:返回現有的項目列表。POST /api/v1/items
:添加一個新項目。OpenAPI 是一個標準化的規範,定義了如何描述 RESTful API。它通過一個結構化的 JSON 或 YAML 文件,描述 API 的所有端點、請求參數、響應格式等。OpenAPI 可以讓開發者生成 API 文件、自動化生成代碼,並且提供清晰的 API 說明。
雖然這兩天的內容與odoo的主要功能較無直接關係,但是數據
交換上這些api 也做了很重要的角色呦,接下來幾天讓我們實際操作odoo的介面吧!